List Lists

Route

/v2/lists

Description

List all policy configuration lists used in protection and inspection policies. Lists contain collections of values like file extensions, domains, or keywords.

Method

GET

Inputs

Parameter	Type	Required	Description
type	string	No	Filter by list type (file_extension, domain, keyword, etc.)
name	string	No	Filter by list name (partial match)
page_size	integer	No	Number of results per page (max 100, default 50)
page_token	string	No	Token for next page of results

Query Parameters Example

GET /v2/lists?type=file_extension&name=office&page_size=25

Output

Field	Type	Description
lists	array[List]	Array of list objects
next_page_token	string	Token for retrieving next page
total_count	integer	Total number of lists

List Object Structure

Field	Type	Description
id	string	Unique list identifier
name	string	List name
description	string	List description
type	string	List type (file_extension, domain, keyword, etc.)
values	array[string]	List values (first 10 shown)
value_count	integer	Total number of values in list
created_at	string	Creation timestamp (ISO 8601)
updated_at	string	Last update timestamp (ISO 8601)

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "lists": [
    {
      "id": "list-123",
      "name": "Office File Extensions",
      "description": "Common Microsoft Office file extensions",
      "type": "file_extension",
      "values": [".docx", ".xlsx", ".pptx", ".doc", ".xls"],
      "value_count": 15,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "list-456",
      "name": "Social Media Domains",
      "description": "Popular social media websites",
      "type": "domain",
      "values": ["facebook.com", "twitter.com", "linkedin.com"],
      "value_count": 8,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "next_page_token": "eyJwYWdlIjoyLCJsaW1pdCI6NTB9",
  "total_count": 42
}